home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / cexyz100.zip / CEXYZ.DOC next >
Text File  |  1993-08-16  |  18KB  |  418 lines
  1.  
  2.                                 CE-XYZ v1.00
  3.                       A File Transfer Protocol Module
  4.            Supporting Xmodem, Ymodem, Zmodem, and their variants
  5.  
  6.                 Copyright (C) 1993 by Cutting Edge Computing
  7.                             All Rights Reserved.
  8.  
  9.  
  10. ALSO AVAILABLE
  11. --------------
  12. An OS/2 version of CE-XYZ is also available.  CE-XYZ/2 is a full 32-bit
  13. protocol module for OS/2 version 2.0 and higher.  XYZ2-100.ZIP is available
  14. from FidoNet node 1:2240/176, or by calling the BBS at 1-313-743-8464.
  15.  
  16.  
  17. LICENSE AGREEMENT
  18. -----------------
  19. This program is free for non-commercial use.  Commercial users are granted
  20. a license to use CE-XYZ if, and only if, the user has purchased a license
  21. to use The Blue Wave Offline Mail Door.  Your Blue Wave Offline Mail Door
  22. Registration Certificate is sufficient "proof" of license to use this
  23. protocol module.
  24.  
  25. If you are a commercial user and would like to use this protocol module for
  26. other purposes, please write to the address below with contact information
  27. so that we may negotiate a license fee.
  28.  
  29. Software authors that would like to distribute CE-XYZ in their distribution
  30. packages will be granted a license to do so for a reasonable, one-time
  31. licensing fee.  Please contact me at the address below for more
  32. information.  Special hooks are provided in the developer's edition for
  33. executing CE-XYZ directly from your applications, no matter what programming
  34. language you may be using.  Source code is NOT provided - however any minor
  35. cosmetic/color changes, default settings, and a customized title banner can
  36. be done with no extra fee (other than the licensing/redistribution fee).  All
  37. licensing is done with a one-time flat fee.  There are no "per-copy" or
  38. "royalty" fees involved.
  39.  
  40. Cutting Edge Computing
  41. PO Box 90476
  42. Burton, MI  48509
  43.  
  44. FidoNet : 1:2240/176
  45. InterNet: george.hatchew@f176.n2240.z1.fidonet.org
  46.  
  47.  
  48. WARRANTY
  49. --------
  50. There is no warranty for this software, either expressed or implied.  The
  51. user assumes full responsibility for the use of this software.
  52.  
  53.  
  54. SUPPORT
  55. -------
  56. Because this is a "free for non-commercial use" program, no support will be
  57. given for this program, except in the following cases:
  58.  
  59.   1)  User has also registered one of The Blue Wave Offline Mail Doors,
  60.       produced by Cutting Edge Computing.
  61.  
  62.   2)  To commercial users who have paid the licensing fee to Cutting Edge
  63.       Computing.
  64.  
  65.   3)  BBS authors, after they have paid the one-time licensing fee to
  66.       Cutting Edge Computing.
  67.  
  68. General help with this protocol engine can be obtained through the
  69. International FidoNet BLUEWAVE Echo.  Netmail (except in the above cases)
  70. will not be answered, but bug reports will be worked on.
  71.  
  72.  
  73.  
  74.  
  75. PURPOSE
  76. -------
  77. The purpose of this program is to provide a file transfer protocol module
  78. specifically designed for use with The Blue Wave Offline Mail Door.
  79.  
  80. Although the 'windowing' of the transfer screen is designed so that the
  81. current BW mail doors' user status is left on the screen (which is why I
  82. say it is BW-door specific), it can be used in the place of ANY external
  83. protocol module, such as DSZ and GSZ.
  84.  
  85. The file transfer protocol module is excellent for use on BBS systems, as
  86. it provides security against users uploading files to a remote-defined
  87. path on the BBS system.  (The default, and only, mode of batch uploading
  88. is the same as DSZ/GSZ's "restrict" keyword).  Users will not be able to
  89. upload files to any path except for the path that you specify.  Also, the
  90. FTP does not allow the "overwriting" of an existing file.
  91.  
  92.  
  93. DESCRIPTION
  94. -----------
  95. The file transfer protocol (named "CE-XYZ", and referred to as the FTP
  96. throughout the rest of the document) currently supports the following
  97. protocols:
  98.  
  99.   - Zmodem with 32-bit CRC   1024 byte subpackets
  100.   - Zmodem with 16-bit CRC   1024 byte subpackets
  101.   - ZedZap with 32-bit CRC   8192 byte subpackets
  102.   - Ymodem-Batch              128 byte blocks (True Ymodem)
  103.   - Ymodem-1K                1024 byte blocks
  104.   - Ymodem-G                 1024 byte blocks
  105.   - Xmodem-1K                1024 byte blocks
  106.   - Xmodem CRC/Checksum (CRC is the default, fallback to Checksum if remote
  107.                         end doesn't seem to like the CRC method)
  108.  
  109. The FTP can use 3 different methods of "talking" to your serial port:
  110.   - FOSSIL communications (most compatible with FidoNet systems, default)
  111.   - Direct communications (standard for most comm programs)
  112.   - Interrupt driven communications (fastest, takes over INT 14h)
  113.  
  114. Because the FTP can utilize a FOSSIL driver, it can support shared IRQs
  115. (unlike DSZ/GSZ) and "non-standard" IRQs if the FOSSIL driver has the
  116. capability (X00 supports shared IRQs).
  117.  
  118. The FTP is command line driven;  it must be invoked with command line
  119. parameters specifying, at the very least, the locked speed of the port
  120. and the protocol transfer method.
  121.  
  122. In order to accomodate terminal and BBS programs that require the use of
  123. a DSZ-style log file, the FTP will create/append to a DSZLOG-type log file
  124. if the following environment variable is set:
  125.  
  126.   SET CEXYZLOG=cexyz.log
  127.   SET DSZLOG=dsz.log
  128.  
  129. If the CEXYZLOG environment variable is not set, then the driver looks for
  130. the DSZLOG environment variable.  (CEXYZLOG always has precedence over
  131. DSZLOG).  If the DSZLOG environment variable is not set, then no protocol
  132. logging will take place.  The log file generated by CE-XYZ is 100% DSZ
  133. compatible.
  134.  
  135.  
  136. COMMAND LINE PARAMETERS
  137. -----------------------
  138. In order to successfully invoke the FTP, you must use at least the
  139. following command line parameters:
  140.  
  141.   /L or /B to specify either the locked speed or the line speed (or both).
  142.   /R or /S to specify send/receive mode
  143.   /P, if your modem is not on COM1 to specify the port.
  144.  
  145. Below is a description of all available command line parameters.  Any
  146. command line parameter that does not start with a / or a - is assumed to
  147. be the file name(s) to send or receive.  More on file name parameters in
  148. the next section.  All command lines are case insensitive (capital
  149. letters and lower-case letters will do the same thing.)
  150.  
  151.  
  152. * EXAMPLE COMMAND LINE PARAMETERS ARE GIVEN AT THE VERY END OF THIS DOCUMENT *
  153.  
  154.  
  155.   /T<number>   -  By default, the FTP places its window and other
  156.                   information beginning on line number 8 of the display in
  157.                   order to "fit into" the window left by BW mail doors.  By
  158.                   using /T<number>, you can tell the FTP to place the first
  159.                   line of the window beginning on a different line.
  160.  
  161.                   /T1 through /T8 are valid.  If <number> is greater than
  162.                   8, 8 is used.  If <number> is less than 1, 1 is used.
  163.  
  164.   /N<1st_last> -  If you pass a User Name to the protocol engine, the name
  165.                   will be displayed on the screen so you know who is online
  166.                   (mainly for BBS usage).
  167.  
  168.                   /NGeorge_Hatchew would display my name on the left-most
  169.                   column of the display screen.  Please note that an
  170.                   underscore between names IS REQUIRED.
  171.  
  172.   /P<number>   -  Specifies the COM port to use for the file transfer.  If
  173.                   no port is specified, the driver defaults to COM1.  To
  174.                   invoke the driver on COM2, use "/p2".
  175.  
  176.   /L<number>   -  The LOCKED baud rate of the transfer session, if the serial
  177.                   port should be locked.  High speed modem users should use
  178.                   one of /L19200, /L38400, /L57600, or possibly /L9600.  If
  179.                   you do not specify the locked baud rate, the driver will
  180.                   try to open the port at the rate specified with the /B
  181.                   parameter.
  182.  
  183.   /B<number>   -  The actual line speed of the current connection.  If /L
  184.                   is also specified, /B is used for time and CPS
  185.                   estimations ONLY. If you do not have a locked serial
  186.                   port, you should specify the connect rate of modem with
  187.                   /B.  /B300, /B1200, /B2400, /B7200, etc. are some
  188.